Package pl.wendigo.chrome.api.audits

Contains DevTools Protocol Audits domain implementation accessible via AuditsDomain class.

Types

AffectedCookie

data class AffectedCookie(name: String, path: String, domain: String)

Information about a cookie that is affected by an inspector issue.

AffectedFrame

data class AffectedFrame(frameId: FrameId)

Information about the frame affected by an inspector issue.

AffectedRequest

data class AffectedRequest(requestId: RequestId, url: String?)

Information about a request that is affected by an inspector issue.

AuditsDomain

class AuditsDomain : Domain

Audits domain allows investigation of page violations and possible improvements.

BlockedByResponseIssueDetails

data class BlockedByResponseIssueDetails(request: AffectedRequest, parentFrame: AffectedFrame?, blockedFrame: AffectedFrame?, reason: BlockedByResponseReason)

Details for a request that has been blocked with the BLOCKED_BY_RESPONSE code.

BlockedByResponseReason

enum BlockedByResponseReason : Enum<BlockedByResponseReason>

Enum indicating the reason a response has been blocked.

CheckContrastRequest

data class CheckContrastRequest(reportAAA: Boolean?)

Represents request frame that can be used with Audits#checkContrast operation call.

ContentSecurityPolicyIssueDetails

data class ContentSecurityPolicyIssueDetails(blockedURL: String?, violatedDirective: String, isReportOnly: Boolean, contentSecurityPolicyViolationType: ContentSecurityPolicyViolationType, frameAncestor: AffectedFrame?, sourceCodeLocation: SourceCodeLocation?, violatingNodeId: BackendNodeId?)

ContentSecurityPolicyViolationType

enum ContentSecurityPolicyViolationType : Enum<ContentSecurityPolicyViolationType>

CorsIssueDetails

data class CorsIssueDetails(corsErrorStatus: CorsErrorStatus, isWarning: Boolean, request: AffectedRequest, resourceIPAddressSpace: IPAddressSpace?, clientSecurityState: ClientSecurityState?)

Details for a CORS related issue, e.g.

GetEncodedResponseRequest

data class GetEncodedResponseRequest(requestId: RequestId, encoding: String, quality: Double?, sizeOnly: Boolean?)

Represents request frame that can be used with Audits#getEncodedResponse operation call.

GetEncodedResponseResponse

data class GetEncodedResponseResponse(body: String?, originalSize: Int, encodedSize: Int)

Represents response frame that is returned from Audits#getEncodedResponse operation call.

HeavyAdIssueDetails

data class HeavyAdIssueDetails(resolution: HeavyAdResolutionStatus, reason: HeavyAdReason, frame: AffectedFrame)

HeavyAdReason

enum HeavyAdReason : Enum<HeavyAdReason>

HeavyAdResolutionStatus

enum HeavyAdResolutionStatus : Enum<HeavyAdResolutionStatus>

InspectorIssue

data class InspectorIssue(code: InspectorIssueCode, details: InspectorIssueDetails)

An inspector issue reported from the back-end.

InspectorIssueCode

enum InspectorIssueCode : Enum<InspectorIssueCode>

A unique identifier for the type of issue.

InspectorIssueDetails

data class InspectorIssueDetails(sameSiteCookieIssueDetails: SameSiteCookieIssueDetails?, mixedContentIssueDetails: MixedContentIssueDetails?, blockedByResponseIssueDetails: BlockedByResponseIssueDetails?, heavyAdIssueDetails: HeavyAdIssueDetails?, contentSecurityPolicyIssueDetails: ContentSecurityPolicyIssueDetails?, sharedArrayBufferIssueDetails: SharedArrayBufferIssueDetails?, twaQualityEnforcementDetails: TrustedWebActivityIssueDetails?, lowTextContrastIssueDetails: LowTextContrastIssueDetails?, corsIssueDetails: CorsIssueDetails?)

This struct holds a list of optional fields with additional information specific to the kind of issue.

IssueAddedEvent

data class IssueAddedEvent(issue: InspectorIssue) : Event

LowTextContrastIssueDetails

data class LowTextContrastIssueDetails(violatingNodeId: BackendNodeId, violatingNodeSelector: String, contrastRatio: Double, thresholdAA: Double, thresholdAAA: Double, fontSize: String, fontWeight: String)

MixedContentIssueDetails

data class MixedContentIssueDetails(resourceType: MixedContentResourceType?, resolutionStatus: MixedContentResolutionStatus, insecureURL: String, mainResourceURL: String, request: AffectedRequest?, frame: AffectedFrame?)

MixedContentResolutionStatus

enum MixedContentResolutionStatus : Enum<MixedContentResolutionStatus>

MixedContentResourceType

enum MixedContentResourceType : Enum<MixedContentResourceType>

SameSiteCookieExclusionReason

enum SameSiteCookieExclusionReason : Enum<SameSiteCookieExclusionReason>

SameSiteCookieIssueDetails

data class SameSiteCookieIssueDetails(cookie: AffectedCookie, cookieWarningReasons: List<SameSiteCookieWarningReason>, cookieExclusionReasons: List<SameSiteCookieExclusionReason>, operation: SameSiteCookieOperation, siteForCookies: String?, cookieUrl: String?, request: AffectedRequest?)

This information is currently necessary, as the front-end has a difficult time finding a specific cookie.

SameSiteCookieOperation

enum SameSiteCookieOperation : Enum<SameSiteCookieOperation>

SameSiteCookieWarningReason

enum SameSiteCookieWarningReason : Enum<SameSiteCookieWarningReason>

SharedArrayBufferIssueDetails

data class SharedArrayBufferIssueDetails(sourceCodeLocation: SourceCodeLocation, isWarning: Boolean, type: SharedArrayBufferIssueType)

Details for a issue arising from an SAB being instantiated in, or transfered to a context that is not cross-origin isolated.

SharedArrayBufferIssueType

enum SharedArrayBufferIssueType : Enum<SharedArrayBufferIssueType>

SourceCodeLocation

data class SourceCodeLocation(scriptId: ScriptId?, url: String, lineNumber: Int, columnNumber: Int)

TrustedWebActivityIssueDetails

data class TrustedWebActivityIssueDetails(url: String, violationType: TwaQualityEnforcementViolationType, httpStatusCode: Int?, packageName: String?, signature: String?)

TwaQualityEnforcementViolationType

enum TwaQualityEnforcementViolationType : Enum<TwaQualityEnforcementViolationType>